Authentication and Session Establishment

The REST API is accessible via HTTP/HTTPS protocol at /api/v1 prefix.

Example

GET /api/v1/status HTTP/1.1
Host: 10.4.219.229
 

HTTP/1.1 200 OK
Content-Type: application/json
{
    "localTimeStamp": "2010-01-17T17:29:15.000Z",
    "ipAddress": "10.4.219.229",
    "subnetMask": "255.255.0.0",
    "defaultGateway": "10.4.0.1",
    "productType": "Mediant SW",
    "versionID": "7.20A.200.014",
    "protocolType": "SIP",
    "operationalState": "UNLOCKED",
    "highAvailability": "Not Operational",
    "serialNumber": "101780235059663",
    "macAddress": "fa163e6e7e1d",
    "systemUpTime": 161446
}

Each REST request must be authenticated using HTTP Basic Authentication. Provided credentials (username-password) must correspond to a valid device user. Availability of specific REST API endpoints depends on user privilege level. For more information on REST API and user privilege levels, see User Privilege Levels and REST API Access.